Northern Region Eclair Orders and Results FHIR API

(0 reviews)

Post ServiceRequest

Service Request Resource Implementation

This API, implemented on the serviceRequest endpoint, provides the ability to update an Eclair system with details of a service request that has occurred or has a confirmed occurrence date and time.

The Service Request resource represents a request for a healthcare service or action to be performed for a patient, such as an order for a diagnostic test. It includes the description and attributes of the service being ordered.

Reference: http://hl7.org/fhir/R4/servicerequest.html

Element / Node Names	Field	Description	Implementation Notes
identifier	ServiceRequest.identifier.value	Business Identifier for this service request; This is the placer's order number	Automatically generated by Éclair if empty
requisition	ServiceRequest.requisition.value	Business Identifier for this requisition that could comprise more than one service request. This is the placer's group number.	Leave empty if not known and will default to the day after the order is submitted.
status		Status of the service request: active - ready for fulfilment, completed - fulfilled, revoked - cancelled
intent		fixed value - order
priority	ServiceRequest.priority	Valid values are: routine, urgent, asap, stat; Refer to http://hl7\.org/fhir/R4/valueset\-request\-priority\.html	This must match to an Eclair priority within the sending organisation/facility
code	ServiceRequest.code.coding.code	code and name of what is being ordered	This must match to an existing Eclair observation code
location reference	ServiceRequest.locationReference	Reference to a contained Location resource where the order was placed
subject	ServiceRequest.subject	Reference to a contained Patient resource who is the subject of the order
requester		Reference to a contained Practitioner resource that describes the order requestor
specimen		Reference to a specimen resource
occurenceDateTime	ServiceRequest.occurrenceDateTime	Date and time for the collection, can be historical (already collected), future (confirmed collection), or not provided (ad hoc collection)\; This field may be left empty if not known and will be defaulted by Éclair to the day after the order is submitted
supportingInfo	ServiceRequest.supportingInfo	Clinical information for this order in free text format
contained	ServiceRequest.contained	Bundles Observation resources related to the service being ordered together as a single unit within the ServiceRequest resource; Contained resources are tied to the resource that contains them

Other Resources Used for Orders

Bundle Resource

Container for the resources that describe the order; provides a bundle ID which Eclair uses to identify the FHIR message.

Field	Data	Implementation Notes
bundle.id	Message identifier	Similar to a HL7 message id
bundle.type	"message"

MessageHeader & Sending Organisation Resource

Identifies the sending & recipient systems

Field	Data	Implementation Notes
MessageHeader.sender.reference	Reference to the organisation representing the Sender's system
Organization.identifier.id	Organization ID	Matched to an exisitng Éclair faciity
MessageHeader.destination.name	Name of the target system
MessageHeader.source.name	The source application from which the message orginated

Patient Resource

Identifies and describes the patient the order is being placed on.

A client is required to POST a message bundle of contained resources that represent the order to be created:

Field	Data	Implementation Notes
patient.gender	Birth sex of the patient, male/female; Refer to http://hl7\.org/fhir/R4/valueset\-administrative\-gender\.html
patient.identifier.value	NHI	Matched to an Eclair patient alias
patient.identifier.system	The coding system of the ID is NHI: https://standards\.digital\.health\.nz/ns/nhi\-id	Matched to an Eclair patient alias key
patient.name (official)	Family and given names
patient.birthDate	Patient's date of birth
patient.address (home)	Patient address made up of: address lines, city, state, country, code

Practitioner Resource

A healthcare practitioner involved in the order either as a requestor or a recipient of the subsequent reports (copy to).

Field	Data	Implementation Notes
Practitioner.identifier.value (official)	Practitioner ID	Matched to an Éclair Provider ID
Practitioner.identifier.system (official)	The coding system of the ID is HPI CPN: https://standards\.digital\.health\.nz/id/hpi\-person or other local system	Matched to an Eclair Provider ID Scheme, HI or local
Practitioner.name (official)	The name associated with the healthcare practitioner. Composed of Provider Family name, Given names plus suffix

Location Resource

A healthcare location involved in the placing of this order

Field	Data	Implementation Notes
Location.identifier.id	Location ID	Matched to an Éclair Location Id
Location.identifier.system	The coding system of the ID; HPI Facility: https://standards\.digital\.health\.nz/id/hpi\-location\-id or other location system
Location.name	Location name

Observation Resource

Each resource represents a piece of information about the patient, the patient’s health status, or the context involved in the order. In a FHIR

Bundle, Observation resources not contained within a ServiceRequest resource relate to the patient, while Observation resources included within

a ServiceRequest resource as contained resources provide additional information related to the service being ordered.

Field	Data	Implementation Notes
Observation.code.coding.code	Observation code	Matched to an Eclair Observation Code
Observation.code.coding.system	The coding system of the observation code: LN or local	Matched to an Eclair Observation Code Scheme
Observation.valueString	A string representation of the observation's actual result
Observation.subject	Reference to a contained Patient Resource who is the subject of the order

PractitionerRole Resource

Describes a practitioner at a location to be used as a destination for report copy-tos.

Field	Data	Implementation Notes
PractitionerRole.practitioner.reference	Reference to a contained Practitioner Resource
PractitionerRole.location.reference	Reference to a contained Location Resource

CommunicationRequest Resource

The request to send copy tos to practitioners or practitionerRoles.

Field	Data	Implementation Notes
CommunicationRequest.recipient.reference	Reference to a contained PractitionerRole resource	Intended recipients of the report

Sample Request Payload

{
  "resourceType": "Bundle",
  "id": "19986",
  "type": "message",
  "entry": [
    {
      "resource": {
        "resourceType": "MessageHeader",
        "id": "19986",
        "destination": [
          {
            "name": "APHGULTRA"
          }
        ],
        "source": {
          "name": "ECLAIR"
        },
        "sender": {
          "reference": "3554B97B-2D35-4D8D-A92C-6072BA044FD0",
          "display": "DIPR"
        }
      }
    },
    {
      "resource": {
        "resourceType": "Organization",
        "id": "3554B97B-2D35-4D8D-A92C-6072BA044FD0",
        "identifier": [
          {
            "id": "GREB",
            "system": ""
          }
        ],
        "name": "DIPR System"
      }
    },
    {
      "resource": {
        "resourceType": "Patient",
        "id": "df49fae1-bf4f-47e4-96df-ac23d7970523",
        "gender": "female",
        "identifier": [
          {
            "use": "official",
            "type": {
              "coding": [
                {
                  "system": "https://standards.digital.health.nz/ns/nhi-id",
                  "code": "National Health Index (NHI)"
                }
              ],
              "text": "National Health Index (NHI)"
            },
            "system": "https://standards.digital.health.nz/ns/nhi-id",
            "value": "LBU7687"
          }
        ],
        "name": [
          {
            "use": "official",
            "family": "Lennard",
            "given": [
              "Jana"
            ]
          }
        ],
        "birthDate": "2022-05-03",
        "deceasedBoolean": false,
        "address": [
          {
            "use": "home",
            "type": "both",
            "line": [
              "Carlton Gore Road"
            ],
            "city": "Auckland",
            "postalCode": "1024"
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Practitioner",
        "id": "af5b8663-aa6e-400b-b6d9-c837b3a3e12f",
        "identifier": [
          {
            "use": "official",
            "system": "https://standards.digital.health.nz/id/hpi-person",
            "value": "92ZZRR"
          }
        ],
        "name": [
          {
            "use": "official",
            "family": "HILL",
            "given": [
              "DAVID"
            ],
            "suffix": [
              "DR"
            ]
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Location",
        "id": "EDA8315F-E72F-4D75-B77B-34212B0BB01E",
        "identifier": [
          {
            "id": "F37094-J",
            "system": "https://standards.digital.health.nz/id/hpi-location-id"
          }
        ],
        "name": "Akld City Rooms"
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "SCL",
              "code": "OPTOFF",
              "display": "Data Reposititory Opt off?"
            }
          ]
        },
        "valueString": "OptOff"
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "SCL",
              "code": "Resident",
              "display": "Eligible for Publicly funded services?"
            }
          ]
        },
        "valueString": "Yes"
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "SCL",
              "code": "DRREF",
              "display": "Doctor Reference:"
            }
          ]
        },
        "valueString": "doc ref"
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "SCL",
              "code": "COPYTO",
              "display": "Copy to Patient :"
            }
          ]
        },
        "valueString": "Yes"
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "LN",
              "code": "49541-6",
              "display": "FASTING"
            }
          ]
        },
        "valueString": "Y"
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "SCL",
              "code": "PREG",
              "display": "Gestation (weeks)"
            }
          ]
        },
        "valueString": "20"
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "LN",
              "code": "8665-2",
              "display": "Last Menstrual Period"
            }
          ]
        },
        "valueString": "22-6-22"
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "SCL",
              "code": "PHLEB",
              "display": "Phlebotomist Comment"
            }
          ]
        },
        "valueString": "collected"
      }
    },
    {
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "AF0231A6-7678-4B60-B47F-DDB59F0095AA",
        "identifier": [
          {
            "system": "",
            "value": "AAA00011123ORD-CBC"
          }
        ],
        "requisition": {
          "system": "",
          "value": "AAA00011123"
        },
        "occurrenceDateTime": "2022-07-21T09:13:00+12:00",
        "status": "active",
        "intent": "order",
        "priority": "routine",
        "code": {
          "coding": [
            {
              "system": "SCL",
              "code": "ORD-CBC"
            }
          ],
          "text": "Complete Blood Count"
        },
        "locationReference": {
          "reference": "EDA8315F-E72F-4D75-B77B-34212B0BB01E"
        },
        "subject": {
          "reference": "df49fae1-bf4f-47e4-96df-ac23d7970523",
          "display": "Lennard, Jana"
        },
        "requester": {
          "reference": "af5b8663-aa6e-400b-b6d9-c837b3a3e12f"
        },
        "supportingInfo": [
          {
            "reference": "Testing a fhir cbc order"
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "AF0231A6-7678-4B60-B47F-DDB59F0095AA-2",
        "identifier": [
          {
            "system": "",
            "value": "AAA00011123ORD-LFT"
          }
        ],
        "requisition": {
          "system": "",
          "value": "AAA00011123"
        },
        "occurrenceDateTime": "2022-07-21T09:13:00+12:00",
        "status": "active",
        "intent": "order",
        "priority": "routine",
        "code": {
          "coding": [
            {
              "system": "SCL",
              "code": "ORD-LFT"
            }
          ],
          "text": "Liver Function Tests"
        },
        "locationReference": {
          "reference": "EDA8315F-E72F-4D75-B77B-34212B0BB01E"
        },
        "subject": {
          "reference": "df49fae1-bf4f-47e4-96df-ac23d7970523",
          "display": "Lennard, Jana"
        },
        "requester": {
          "reference": "af5b8663-aa6e-400b-b6d9-c837b3a3e12f"
        },
        "supportingInfo": [
          {
            "reference": "Testing a fhir lft order"
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Location",
        "id": "DCA1374E-A77E-4187-B56F-2B6873BF2169",
        "identifier": [
          {
            "id": "F00024-A",
            "system": "https://standards.digital.health.nz/id/hpi-location-id"
          }
        ],
        "name": "Tamaki Family Health Centre"
      }
    },
    {
      "resource": {
        "resourceType": "Location",
        "id": "8C8F7D9D-F873-45F8-9139-C17C85A3A3C8",
        "identifier": [
          {
            "id": "F00027-G",
            "system": "https://standards.digital.health.nz/id/hpi-location-id"
          }
        ],
        "name": "Westmere Medical Centre"
      }
    },
    {
      "resource": {
        "resourceType": "Practitioner",
        "id": "5619DC70-E784-460C-9D1E-0346228A3835",
        "identifier": [
          {
            "use": "official",
            "system": "https://standards.digital.health.nz/id/hpi-person",
            "value": "91ZZTH"
          }
        ],
        "name": [
          {
            "use": "official",
            "family": "Zoidberg",
            "given": [
              "John",
              "Adam"
            ],
            "suffix": [
              "DR"
            ]
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Practitioner",
        "id": "3EC0AEFD-E3ED-4CE1-86BB-EC2B149E2CD4",
        "identifier": [
          {
            "use": "official",
            "system": "https://standards.digital.health.nz/id/hpi-person",
            "value": "91ZZZK"
          }
        ],
        "name": [
          {
            "use": "official",
            "family": "Winchester",
            "given": [
              "Charles",
              "Emerson"
            ],
            "suffix": [
              "MAJ"
            ]
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "PractitionerRole",
        "id": "73F1CCD4-D84A-4425-9864-38CFA1263BD0",
        "practitioner": {
          "reference": "5619DC70-E784-460C-9D1E-0346228A3835"
        },
        "location": [
          {
            "reference": "DCA1374E-A77E-4187-B56F-2B6873BF2169"
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "PractitionerRole",
        "id": "222AD511-BF42-45F1-BE2D-D25D38A51303",
        "practitioner": {
          "reference": "3EC0AEFD-E3ED-4CE1-86BB-EC2B149E2CD4"
        },
        "location": [
          {
            "reference": "8C8F7D9D-F873-45F8-9139-C17C85A3A3C8"
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "CommunicationRequest",
        "id": "A7654EFC-89EE-41EB-BB00-450E8ED7EE75",
        "basedOn": [
          {
            "reference": "AF0231A6-7678-4B60-B47F-DDB59F0095AA"
          }
        ],
        "recipient": [
          {
            "reference": "73F1CCD4-D84A-4425-9864-38CFA1263BD0"
          },
          {
            "reference": "222AD511-BF42-45F1-BE2D-D25D38A51303"
          }
        ]
      }
    }
  ]
}